improve docs
authorJoey Hess <joeyh@joeyh.name>
Wed, 17 May 2023 17:32:47 +0000 (13:32 -0400)
committerJoey Hess <joeyh@joeyh.name>
Wed, 17 May 2023 17:32:47 +0000 (13:32 -0400)
The man pages for these were not really clear that they add new files.

doc/git-annex-assistant.mdwn
doc/git-annex-watch.mdwn

index 18f9341e2ac38a82db908a11c541f9930c371947..c0254f61561bf1083bd347fcaf30838f73466418 100644 (file)
@@ -9,7 +9,17 @@ git annex assistant
 # DESCRIPTION
 
 Watches for changes to files in the current directory and its subdirectories,
-and automatically syncs them to other remotes.
+and automatically syncs them to other remotes. This includes adding new
+files. New files published to remotes by others are also automatically
+downloaded.
+
+By default, all new files in the directory will be added to the repository.
+(Including dotfiles.) To block some files from being added, use
+`.gitignore` files.
+  
+By default, all files that are added are added to the annex, the same
+as when you run `git annex add`. If you configure annex.largefiles,
+files that it does not match will instead be added with `git add`.
 
 # OPTIONS
 
index 405a7d6446158e45533c3cbb9ff56686fdaed624..b65b4dc657c46f665077652f1656e58a531d6fcc 100644 (file)
@@ -14,7 +14,7 @@ deleted, copied, and moved files. With this running as a daemon in the
 background, you no longer need to manually run git commands when
 manipulating your files.
   
-By default, all files in the directory will be added to the repository.
+By default, all new files in the directory will be added to the repository.
 (Including dotfiles.) To block some files from being added, use
 `.gitignore` files.